home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxSelec.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  5.2 KB  |  132 lines
  1. //******************************************************************************
  2. //    File: tsxSelect.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: The Selection Mechanism
  5. //******************************************************************************
  6.  
  7. #ifndef TSXSELECT_H
  8. #define TSXSELECT_H
  9.  
  10. #include "tsxTypes.h"
  11.  
  12.  
  13. //------------------------------------------------------------------------------
  14. //------------------------------------------------------------------------------
  15.  
  16. // This describes the API to trueSpace's selection mechanism. Several trueSpace
  17. // functions require their target object to be currently selected.
  18. // Selectable objects are:
  19. //    - GNodes
  20. //    - Axes
  21. // trueSpace may allow selection of some unsupported object types (which
  22. // show up as e_tsxUNDEFINED). Call the appropriate Selection function
  23. // (e.g. tsxSelectNext) until a TSX-supported Node type is selected.
  24.  
  25.  
  26. //------------------------------------------------------------------------------
  27. //    Select Modes
  28. //------------------------------------------------------------------------------
  29.  
  30. enum tsxSELECTMODE {
  31.     e_tsxSELECT,    // Ordinary Selection of a Node.
  32.     e_tsxERASE,        // For selecting an object after erasing curr obj.
  33.     e_tsxGLUE        // For selecting an object to attach to curr obj.
  34. };
  35.  
  36.  
  37. //------------------------------------------------------------------------------
  38. //    Tests
  39. //------------------------------------------------------------------------------
  40.  
  41. // e_tsxTRUE if pSobj is of supported selectable type (see doc above).
  42. TSXAPIFN tsxBOOL tsxIsSelectable( tsxSOBJ* pSobj );
  43.  
  44. // e_tsxTRUE if pSobj is part of a selected Object/Group
  45. TSXAPIFN tsxBOOL tsxIsSelected( tsxSOBJ* pSobj );
  46.  
  47.  
  48. //------------------------------------------------------------------------------
  49. //    Accessing/Making/Changing a Selection
  50. //------------------------------------------------------------------------------
  51.  
  52. // Get pointer to the currently selected object.
  53. // Note: trueSpace may select objects that are not currently supported in TSX.
  54. TSXAPIFN tsxSOBJ* tsxGetCurrentSelection();
  55.  
  56. // Essentially same (with correct args) as picking an object with the mouse.
  57. // Make specified pSobj the current selection.
  58. // Set `bNoDraw' to e_tsxTRUE if you do not wish the object to be redrawn in
  59. // "selected" mode.  Use this feature carefully, as it might result in all
  60. // or portions of the object being erased when the next object is selected.
  61. // Primarily meant as a mechanism for temporarily selecting an object for
  62. // operations, and to be followed by a scene refresh.
  63. TSXAPIFN void tsxSelectSobj(
  64.     tsxSOBJ* pSobj,        //Must be `tsxIsSelectable'
  65.     tsxSELECTMODE selmode,
  66.     tsxBOOL bNoDraw        //TRUE if Views should not be updated.
  67.     );
  68.  
  69. // Same function as called on the [downArrow] button.
  70. // Selects a child of the Currobj.
  71. // Views updated.
  72. TSXAPIFN void tsxSelectDown();
  73.  
  74. // Same function as called on the [upArrow] button.
  75. // Selects parent of Currobj.
  76. // Views updated.
  77. TSXAPIFN void tsxSelectUp();
  78.  
  79. // Same function as called on the <rightArrow> key.
  80. // Selects a sibling of the Currobj, following Currobj in the list.
  81. // Views updated.
  82. TSXAPIFN void tsxSelectNext();
  83.  
  84. // Same function as called on the <leftArrow> key.
  85. // Selects a sibling of the Currobj, preceeding Currobj in the list.
  86. // Views updated.
  87. TSXAPIFN void tsxSelectPrev();
  88.  
  89.  
  90. //------------------------------------------------------------------------------
  91. //    Callback
  92. //------------------------------------------------------------------------------
  93.  
  94. // The function `func' will get called each time there is a change in the
  95. // current selection, made by the normal trueSpace mouse tool or through a
  96. // call to one of the above functions for making/changing a selection, while
  97. // an eXtension is active. Use 0 (NULL) to remove an installed callback.
  98. // Installation and callback works only while an eXtension is active.
  99. // Returns the previous callback function pointer (or 0 if none).
  100. TSXAPIFN tsxBasicCallbackFP tsxSelectionChangedCB(
  101.     int tsxid,            // Id of this eXtn (see tsxGetData).
  102.     tsxBasicCallbackFP func    // This function gets installed as the callback.
  103.     );
  104.  
  105.  
  106. //------------------------------------------------------------------------------
  107. //    Misc fns dealing with Currobj
  108. //------------------------------------------------------------------------------
  109.  
  110. // Removes the current object and substitutes it with pNewGNode.
  111. // If the selected part of the current object does not include it's children,
  112. // the children are moved to the new object and removed from the current
  113. // object, leaving the children non-selected. pNewGNode is installed in
  114. // Currobj's location, and becomes the new Currobj. The old Currobj is deleted.
  115. TSXAPIFN void tsxCurrobjReplace(
  116.     tsxGNODE* pNewGNode,
  117.     tsxBOOL bNoDraw       //TRUE if View displays should not be refreshed.
  118.     );
  119.  
  120. // Copy curr obj and add to scene at top level, making it new currobj.
  121. TSXAPIFN tsxERR tsxCurrobjCopy();
  122.  
  123. // Draw the curr selection
  124. TSXAPIFN void tsxCurrobjDraw();
  125.  
  126. // Photo-render the current object in the active view.
  127. TSXAPIFN void tsxCurrobjPhrender();
  128.  
  129.  
  130. //******************************************************************************
  131. #endif //TSXSELECT_H
  132.